using System.Collections.Generic;

namespace Rhinestone.Domain.Services
{
    /// <summary>
    /// The <see cref="IWorkItemsSearchService"/> defines a contract that should be 
    /// implemented by a search service that allows searching for work items.
    /// </summary>
    public interface IWorkItemsSearchService
    {
        /// <summary>
        /// Searches for work items matching the user supplied search text.
        /// </summary>
        /// <param name="searchText">string. The search text used to find matching work items.</param>
        /// <returns>A <see cref="IEnumerable{T}"/> that can be used to enumerate over the search results.</returns>
        IEnumerable<WorkItem> SearchForWorkItems(string searchText);
    }
}